home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 April: Mac OS SDK / Dev.CD Apr 98 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Universal / Interfaces / AIncludes / InputSprocket.a < prev    next >
Encoding:
Text File  |  1998-02-12  |  28.6 KB  |  1,030 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        InputSprocket.a
  3. ;
  4. ;    Contains:    Games Sprockets: InputSprocket interfaaces
  5. ;
  6. ;    Version:    Technology:    Input Sprocket 1.2
  7. ;                Release:    Universal Interfaces 3.1
  8. ;
  9. ;    Copyright:    © 1996-1998 by Apple Computer, Inc., all rights reserved.
  10. ;
  11. ;    Bugs?:        Please include the the file and version information (from above) with
  12. ;                the problem description.  Developers belonging to one of the Apple
  13. ;                developer programs can submit bug reports to:
  14. ;
  15. ;                    devsupport@apple.com
  16. ;
  17. ;
  18.     IF &TYPE('__INPUTSPROCKET__') = 'UNDEFINED' THEN
  19. __INPUTSPROCKET__ SET 1
  20.  
  21.     IF &TYPE('__MACTYPES__') = 'UNDEFINED' THEN
  22.     include 'MacTypes.a'
  23.     ENDIF
  24.     IF &TYPE('__EVENTS__') = 'UNDEFINED' THEN
  25.     include 'Events.a'
  26.     ENDIF
  27.  
  28.     IF &TYPE('USE_OLD_INPUT_SPROCKET_LABELS') = 'UNDEFINED' THEN
  29.     USE_OLD_INPUT_SPROCKET_LABELS: SET 1
  30.     ENDIF
  31.     IF &TYPE('USE_OLD_ISPNEED_STRUCT') = 'UNDEFINED' THEN
  32.     USE_OLD_ISPNEED_STRUCT: SET 1
  33.     ENDIF
  34.     IF TARGET_CPU_PPC THEN
  35. ;  ********************* data types ********************* 
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42. ;  ISpDeviceClass is a general classs of device, example: keyboard, mouse, joystick 
  43. ; typedef OSType                         ISpDeviceClass
  44.  
  45. ;  ISpDeviceIdentifier is a specific device,  example: standard 1-button mouse, 105key ext. kbd. 
  46. ; typedef OSType                         ISpDeviceIdentifier
  47.  
  48. ; typedef OSType                         ISpElementLabel
  49.  
  50. ; typedef OSType                         ISpElementKind
  51.  
  52.  
  53. ;  *************** errors -30420 to -30439***************** 
  54.  
  55. kISpInternalErr                    EQU        -30420
  56. kISpSystemListErr                EQU        -30421
  57. kISpBufferToSmallErr            EQU        -30422
  58. kISpElementInListErr            EQU        -30423
  59. kISpElementNotInListErr            EQU        -30424
  60. kISpSystemInactiveErr            EQU        -30425
  61. kISpDeviceInactiveErr            EQU        -30426
  62. kISpSystemActiveErr                EQU        -30427
  63. kISpDeviceActiveErr                EQU        -30428
  64. kISpListBusyErr                    EQU        -30429
  65. ;  *************** resources **************** 
  66.  
  67. kISpApplicationResourceType        EQU        'isap'
  68. kISpSetListResourceType            EQU        'setl'
  69. kISpSetDataResourceType            EQU        'setd'
  70. ISpApplicationResourceStruct RECORD 0
  71. flags                     ds.l    1                ; offset: $0 (0)
  72. reserved1                 ds.l    1                ; offset: $4 (4)
  73. reserved2                 ds.l    1                ; offset: $8 (8)
  74. reserved3                 ds.l    1                ; offset: $C (12)
  75. sizeof                     EQU *                    ; size:   $10 (16)
  76.                         ENDR
  77.  
  78. kISpAppResFlag_UsesInputSprocket EQU    $00000001            ; true if the application uses InputSprocket
  79. kISpAppResFlag_UsesISpInit        EQU        $00000002            ; true if the calls ISpInit (ie, uses the high level interface, calls ISpConfigure, has a needs list, etc...)
  80. ; 
  81. ; * ISpDeviceDefinition
  82. ; *
  83. ; * This structure provides all the available
  84. ; * information for an input device within the system
  85. ; *
  86. ; 
  87.  
  88. ISpDeviceDefinition        RECORD 0
  89. deviceName                 ds        Str63            ; offset: $0 (0)        ;  a human readable name of the device 
  90. theDeviceClass             ds.l    1                ; offset: $40 (64)        ;  general classs of device example : keyboard, mouse, joystick 
  91. theDeviceIdentifier         ds.l    1                ; offset: $44 (68)        ;  every distinguishable device should have an OSType 
  92. permanentID                 ds.l    1                ; offset: $48 (72)        ;  a cross reboot id unique within that deviceType, 0 if not possible 
  93. flags                     ds.l    1                ; offset: $4C (76)        ;  status flags 
  94. reserved1                 ds.l    1                ; offset: $50 (80)
  95. reserved2                 ds.l    1                ; offset: $54 (84)
  96. reserved3                 ds.l    1                ; offset: $58 (88)
  97. sizeof                     EQU *                    ; size:   $5C (92)
  98.                         ENDR
  99.  
  100. kISpDeviceFlag_HandleOwnEmulation EQU    1
  101. ; 
  102. ; * ISpElementEvent, ISpElementEventPtr
  103. ; *
  104. ; * This is the structure that event data is passed in.
  105. ; *
  106. ; 
  107.  
  108. ISpElementEvent            RECORD 0
  109. when                     ds        AbsoluteTime    ; offset: $0 (0)        ;  this is absolute time on PCI or later, otherwise it is 
  110. ;  0 for the hi 32 bits and TickCount for the low 32 bits 
  111. element                     ds.l    1                ; offset: $8 (8)        ;  a reference to the element that generated this event 
  112. refCon                     ds.l    1                ; offset: $C (12)        ;  for application usage, 0 on the global list 
  113. data                     ds.l    1                ; offset: $10 (16)        ;  the data for this event 
  114. sizeof                     EQU *                    ; size:   $14 (20)
  115.                         ENDR
  116. ; typedef struct ISpElementEvent *        ISpElementEventPtr
  117.  
  118. ; 
  119. ; * ISpElementInfo, ISpElementInfoPtr
  120. ; *
  121. ; * This is the generic definition of an element.
  122. ; * Every element must contain this information.
  123. ; *
  124. ; 
  125.  
  126. ISpElementInfo            RECORD 0
  127. theLabel                 ds.l    1                ; offset: $0 (0)
  128. theKind                     ds.l    1                ; offset: $4 (4)
  129. theString                 ds        Str63            ; offset: $8 (8)
  130. reserved1                 ds.l    1                ; offset: $48 (72)
  131. reserved2                 ds.l    1                ; offset: $4C (76)
  132. sizeof                     EQU *                    ; size:   $50 (80)
  133.                         ENDR
  134. ; typedef struct ISpElementInfo *        ISpElementInfoPtr
  135.  
  136. ; typedef UInt32                         ISpNeedFlagBits
  137.  
  138.     IF USE_OLD_ISPNEED_STRUCT THEN
  139. ISpNeed                    RECORD 0
  140. name                     ds        Str63            ; offset: $0 (0)
  141. iconSuiteResourceId         ds.w    1                ; offset: $40 (64)        ;  resource id of the icon suite 
  142. reserved                 ds.w    1                ; offset: $42 (66)
  143. theKind                     ds.l    1                ; offset: $44 (68)
  144. theLabel                 ds.l    1                ; offset: $48 (72)
  145. flags                     ds.l    1                ; offset: $4C (76)
  146. reserved1                 ds.l    1                ; offset: $50 (80)
  147. reserved2                 ds.l    1                ; offset: $54 (84)
  148. reserved3                 ds.l    1                ; offset: $58 (88)
  149. sizeof                     EQU *                    ; size:   $5C (92)
  150.                         ENDR
  151.     ELSE
  152. ISpNeed                    RECORD 0
  153. name                     ds        Str63            ; offset: $0 (0)        ;  human-readable string 
  154. iconSuiteResourceId         ds.w    1                ; offset: $40 (64)        ;  resource id of the icon suite 
  155. playerNum                 ds.b    1                ; offset: $42 (66)        ;  used for multi-player support 
  156. group                     ds.b    1                ; offset: $43 (67)        ;  used to group related needs (eg, look left and look right button needs) 
  157. theKind                     ds.l    1                ; offset: $44 (68)
  158. theLabel                 ds.l    1                ; offset: $48 (72)
  159. flags                     ds.l    1                ; offset: $4C (76)
  160. reserved1                 ds.l    1                ; offset: $50 (80)
  161. reserved2                 ds.l    1                ; offset: $54 (84)
  162. reserved3                 ds.l    1                ; offset: $58 (88)
  163. sizeof                     EQU *                    ; size:   $5C (92)
  164.                         ENDR
  165.     ENDIF    ; USE_OLD_ISPNEED_STRUCT
  166.  
  167. kISpNeedFlag_NoMultiConfig        EQU        $00000001            ; once this need is autoconfigured to one device dont autoconfigure to anything else
  168. kISpNeedFlag_Utility            EQU        $00000002            ; this need is a utility function (like show framerate) which would not typically be assigned to anything but the keyboard
  169. kISpNeedFlag_PolledOnly            EQU        $00000004
  170. kISpNeedFlag_EventsOnly            EQU        $00000008            ; *** kISpElementKind specific flags ***
  171.                                                             ; these are flags specific to kISpElementKind_Button
  172. kISpNeedFlag_Button_AlreadyAxis    EQU        $10000000            ; there is a axis version of this button need
  173. kISpNeedFlag_Button_ClickToggles EQU    $20000000
  174. kISpNeedFlag_Button_ActiveWhenDown EQU    $40000000            ; these are flags specific to kISpElementKind_DPad
  175.                                                             ; these are flags specific to kISpElementKind_Axis
  176. kISpNeedFlag_Axis_AlreadyButton    EQU        $10000000            ; there is a button version of this axis need
  177. kISpNeedFlag_Axis_Asymetric        EQU        $20000000            ; this axis need is asymetric    
  178.                                                             ; these are flags specific to kISpElementKind_Delta
  179. kISpNeedFlag_Delta_AlreadyAxis    EQU        $10000000            ; there is a axis version of this delta need
  180. ; 
  181. ; *
  182. ; * These are the current built values for ISpDeviceClass
  183. ; *
  184. ; 
  185.  
  186.  
  187. kISpDeviceClass_SpeechRecognition EQU    'talk'
  188. kISpDeviceClass_Mouse            EQU        'mous'
  189. kISpDeviceClass_Keyboard        EQU        'keyd'
  190. kISpDeviceClass_Joystick        EQU        'joys'
  191. kISpDeviceClass_Wheel            EQU        'whel'
  192. kISpDeviceClass_Pedals            EQU        'pedl'
  193. kISpDeviceClass_Levers            EQU        'levr'
  194. kISpDeviceClass_Tickle            EQU        'tckl'                ; a device of this class requires ISpTickle
  195. ; 
  196. ; * These are the current built in ISpElementKind's
  197. ; * 
  198. ; * These are all OSTypes.
  199. ; *
  200. ; 
  201.  
  202.  
  203. kISpElementKind_Button            EQU        'butn'
  204. kISpElementKind_DPad            EQU        'dpad'
  205. kISpElementKind_Axis            EQU        'axis'
  206. kISpElementKind_Delta            EQU        'dlta'
  207. kISpElementKind_Movement        EQU        'move'
  208. kISpElementKind_Virtual            EQU        'virt'
  209.  
  210. ; 
  211. ; *
  212. ; * These are the current built in ISpElementLabel's
  213. ; *
  214. ; * These are all OSTypes.
  215. ; *
  216. ; 
  217.  
  218.     IF USE_OLD_INPUT_SPROCKET_LABELS THEN
  219.  
  220.                                                             ; axis 
  221. kISpElementLabel_XAxis            EQU        'xaxi'
  222. kISpElementLabel_YAxis            EQU        'yaxi'
  223. kISpElementLabel_ZAxis            EQU        'zaxi'
  224. kISpElementLabel_Rx                EQU        'rxax'
  225. kISpElementLabel_Ry                EQU        'ryax'
  226. kISpElementLabel_Rz                EQU        'rzax'
  227. kISpElementLabel_Gas            EQU        'gasp'
  228. kISpElementLabel_Brake            EQU        'brak'
  229. kISpElementLabel_Clutch            EQU        'cltc'
  230. kISpElementLabel_Throttle        EQU        'thrt'
  231. kISpElementLabel_Trim            EQU        'trim'                ; direction pad 
  232. kISpElementLabel_POVHat            EQU        'povh'
  233. kISpElementLabel_PadMove        EQU        'move'                ; buttons 
  234. kISpElementLabel_Fire            EQU        'fire'
  235. kISpElementLabel_Start            EQU        'strt'
  236. kISpElementLabel_Select            EQU        'optn'
  237.     ENDIF    ; USE_OLD_INPUT_SPROCKET_LABELS
  238.  
  239.                                                             ; generic 
  240. kISpElementLabel_None            EQU        'none'                ; axis 
  241. kISpElementLabel_Axis_XAxis        EQU        'xaxi'
  242. kISpElementLabel_Axis_YAxis        EQU        'yaxi'
  243. kISpElementLabel_Axis_ZAxis        EQU        'zaxi'
  244. kISpElementLabel_Axis_Rx        EQU        'rxax'
  245. kISpElementLabel_Axis_Ry        EQU        'ryax'
  246. kISpElementLabel_Axis_Rz        EQU        'rzax'
  247. kISpElementLabel_Axis_Roll        EQU        'rzax'
  248. kISpElementLabel_Axis_Pitch        EQU        'rxax'
  249. kISpElementLabel_Axis_Yaw        EQU        'ryax'
  250. kISpElementLabel_Axis_RollTrim    EQU        'rxtm'
  251. kISpElementLabel_Axis_PitchTrim    EQU        'trim'
  252. kISpElementLabel_Axis_YawTrim    EQU        'rytm'
  253. kISpElementLabel_Axis_Gas        EQU        'gasp'
  254. kISpElementLabel_Axis_Brake        EQU        'brak'
  255. kISpElementLabel_Axis_Clutch    EQU        'cltc'
  256. kISpElementLabel_Axis_Throttle    EQU        'thrt'
  257. kISpElementLabel_Axis_Trim        EQU        'trim'
  258. kISpElementLabel_Axis_Rudder    EQU        'rudd'                ; delta 
  259. kISpElementLabel_Delta_X        EQU        'xdlt'
  260. kISpElementLabel_Delta_Y        EQU        'ydlt'
  261. kISpElementLabel_Delta_Z        EQU        'zdlt'
  262. kISpElementLabel_Delta_Rx        EQU        'rxdl'
  263. kISpElementLabel_Delta_Ry        EQU        'rydl'
  264. kISpElementLabel_Delta_Rz        EQU        'rzdl'
  265. kISpElementLabel_Delta_Roll        EQU        'rzdl'
  266. kISpElementLabel_Delta_Pitch    EQU        'rxdl'
  267. kISpElementLabel_Delta_Yaw        EQU        'rydl'                ; direction pad 
  268. kISpElementLabel_Pad_POV        EQU        'povh'
  269. kISpElementLabel_Pad_Move        EQU        'move'                ; buttons 
  270. kISpElementLabel_Btn_Fire        EQU        'fire'
  271. kISpElementLabel_Btn_SecondaryFire EQU    'sfir'
  272. kISpElementLabel_Btn_Jump        EQU        'jump'
  273. kISpElementLabel_Btn_PauseResume EQU    'strt'                ; kISpElementLabel_Btn_PauseResume automatically binds to escape 
  274. kISpElementLabel_Btn_Select        EQU        'optn'
  275. kISpElementLabel_Btn_SlideLeft    EQU        'blft'
  276. kISpElementLabel_Btn_SlideRight    EQU        'brgt'
  277. kISpElementLabel_Btn_MoveForward EQU    'btmf'
  278. kISpElementLabel_Btn_MoveBackward EQU    'btmb'
  279. kISpElementLabel_Btn_TurnLeft    EQU        'bttl'
  280. kISpElementLabel_Btn_TurnRight    EQU        'bttr'
  281. kISpElementLabel_Btn_LookLeft    EQU        'btll'
  282. kISpElementLabel_Btn_LookRight    EQU        'btlr'
  283. kISpElementLabel_Btn_LookUp        EQU        'btlu'
  284. kISpElementLabel_Btn_LookDown    EQU        'btld'
  285. kISpElementLabel_Btn_Next        EQU        'btnx'
  286. kISpElementLabel_Btn_Previous    EQU        'btpv'
  287. kISpElementLabel_Btn_SideStep    EQU        'side'
  288. kISpElementLabel_Btn_Run        EQU        'quik'
  289. kISpElementLabel_Btn_Look        EQU        'blok'
  290. ; 
  291. ; *
  292. ; * direction pad data & configuration information
  293. ; *
  294. ; 
  295.  
  296. ; typedef UInt32                         ISpDPadData
  297.  
  298.  
  299. kISpPadIdle                        EQU        0
  300. kISpPadLeft                        EQU        1
  301. kISpPadUpLeft                    EQU        2
  302. kISpPadUp                        EQU        3
  303. kISpPadUpRight                    EQU        4
  304. kISpPadRight                    EQU        5
  305. kISpPadDownRight                EQU        6
  306. kISpPadDown                        EQU        7
  307. kISpPadDownLeft                    EQU        8
  308. ISpDPadConfigurationInfo RECORD 0
  309. id                         ds.l    1                ; offset: $0 (0)        ;  ordering 1..n, 0 = no relavent ordering of direction pads 
  310. fourWayPad                 ds.b    1                ; offset: $4 (4)        ;  true if this pad can only produce idle + four directions 
  311.                          ORG 6
  312. sizeof                     EQU *                    ; size:   $6 (6)
  313.                         ENDR
  314. ; 
  315. ; *
  316. ; * button data & configuration information
  317. ; *
  318. ; 
  319.  
  320. ; typedef UInt32                         ISpButtonData
  321.  
  322.  
  323. kISpButtonUp                    EQU        0
  324. kISpButtonDown                    EQU        1
  325. ISpButtonConfigurationInfo RECORD 0
  326. id                         ds.l    1                ; offset: $0 (0)        ;  ordering 1..n, 0 = no relavent ordering of buttons 
  327. sizeof                     EQU *                    ; size:   $4 (4)
  328.                         ENDR
  329. ; 
  330. ; *
  331. ; * axis data & configuration information 
  332. ; *
  333. ; 
  334.  
  335. ; typedef UInt32                         ISpAxisData
  336.  
  337. ISpAxisConfigurationInfo RECORD 0
  338. symetricAxis             ds.b    1                ; offset: $0 (0)        ;  axis is symetric, i.e. a joystick is symetric and a gas pedal is not 
  339.                          ORG 2
  340. sizeof                     EQU *                    ; size:   $2 (2)
  341.                         ENDR
  342. ; typedef Fixed                         ISpDeltaData
  343.  
  344. ISpDeltaConfigurationInfo RECORD 0
  345. reserved1                 ds.l    1                ; offset: $0 (0)
  346. reserved2                 ds.l    1                ; offset: $4 (4)
  347. sizeof                     EQU *                    ; size:   $8 (8)
  348.                         ENDR
  349. ISpMovementData            RECORD 0
  350. xAxis                     ds.l    1                ; offset: $0 (0)
  351. yAxis                     ds.l    1                ; offset: $4 (4)
  352. direction                 ds.l    1                ; offset: $8 (8)        ;  ISpDPadData version of the movement 
  353. sizeof                     EQU *                    ; size:   $C (12)
  354.                         ENDR
  355.  
  356. kISpVirtualElementFlag_UseTempMem EQU    1
  357.  
  358. kISpElementListFlag_UseTempMem    EQU        1
  359.  
  360. kISpFirstIconSuite                EQU        30000
  361. kISpLastIconSuite                EQU        30100
  362. kISpNoneIconSuite                EQU        30000
  363. ;  ********************* user level functions ********************* 
  364.  
  365.  
  366. ; 
  367. ; *
  368. ; * startup / shutdown
  369. ; *
  370. ; 
  371.  
  372. ;
  373. ; extern OSStatus ISpStartup(void )
  374. ;
  375.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  376.         IMPORT_CFM_FUNCTION ISpStartup
  377.     ENDIF
  378.  
  379. ;  1.1 or later
  380. ;
  381. ; extern OSStatus ISpShutdown(void )
  382. ;
  383.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  384.         IMPORT_CFM_FUNCTION ISpShutdown
  385.     ENDIF
  386.  
  387. ;  1.1 or later
  388. ; 
  389. ; *
  390. ; * polling
  391. ; *
  392. ; 
  393.  
  394. ;
  395. ; extern OSStatus ISpTickle(void )
  396. ;
  397.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  398.         IMPORT_CFM_FUNCTION ISpTickle
  399.     ENDIF
  400.  
  401. ;  1.1 or later
  402. ; ********** user interface functions *********
  403.  
  404. ;
  405. ; extern NumVersion ISpGetVersion(void )
  406. ;
  407.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  408.         IMPORT_CFM_FUNCTION ISpGetVersion
  409.     ENDIF
  410.  
  411. ; 
  412. ; *
  413. ; * ISpElement_NewVirtual(ISpElementReference *outElement);
  414. ; *
  415. ; 
  416.  
  417. ;
  418. ; extern OSStatus ISpElement_NewVirtual(UInt32 dataSize, ISpElementReference *outElement, UInt32 flags)
  419. ;
  420.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  421.         IMPORT_CFM_FUNCTION ISpElement_NewVirtual
  422.     ENDIF
  423.  
  424. ; 
  425. ; *
  426. ; * ISpElement_NewVirtualFromNeeds(UInt32 count, ISpNeeds *needs, ISpElementReference *outElements);
  427. ; *
  428. ; 
  429.  
  430. ;
  431. ; extern OSStatus ISpElement_NewVirtualFromNeeds(UInt32 count, ISpNeed *needs, ISpElementReference *outElements, UInt32 flags)
  432. ;
  433.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  434.         IMPORT_CFM_FUNCTION ISpElement_NewVirtualFromNeeds
  435.     ENDIF
  436.  
  437. ; 
  438. ; *
  439. ; * ISpElement_DisposeVirtual(inElement);
  440. ; *
  441. ; 
  442.  
  443. ;
  444. ; extern OSStatus ISpElement_DisposeVirtual(UInt32 count, ISpElementReference *inElements)
  445. ;
  446.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  447.         IMPORT_CFM_FUNCTION ISpElement_DisposeVirtual
  448.     ENDIF
  449.  
  450. ; 
  451. ; * ISpInit
  452. ; *
  453. ; 
  454.  
  455. ;
  456. ; extern OSStatus ISpInit(UInt32 count, ISpNeed *needs, ISpElementReference *inReferences, OSType appCreatorCode, OSType subCreatorCode, UInt32 flags, short setListResourceId, UInt32 reserved)
  457. ;
  458.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  459.         IMPORT_CFM_FUNCTION ISpInit
  460.     ENDIF
  461.  
  462.  
  463. ; 
  464. ; * ISpConfigure
  465. ; *
  466. ; 
  467.  
  468. ;
  469. ; extern OSStatus ISpConfigure(ISpEventProcPtr inEventProcPtr)
  470. ;
  471.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  472.         IMPORT_CFM_FUNCTION ISpConfigure
  473.     ENDIF
  474.  
  475. ; 
  476. ; *
  477. ; * ISpStop
  478. ; *
  479. ; 
  480.  
  481. ;
  482. ; extern OSStatus ISpStop(void )
  483. ;
  484.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  485.         IMPORT_CFM_FUNCTION ISpStop
  486.     ENDIF
  487.  
  488. ; 
  489. ; *
  490. ; * ISpSuspend, ISpResume
  491. ; *
  492. ; * ISpSuspend turns all devices off and allocates memory so that the state may be later resumed.
  493. ; * ISpResume resumes to the previous state of the system after a suspend call.
  494. ; * 
  495. ; * Return Codes
  496. ; * memFullErr
  497. ; *
  498. ; 
  499.  
  500. ;
  501. ; extern OSStatus ISpSuspend(void )
  502. ;
  503.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  504.         IMPORT_CFM_FUNCTION ISpSuspend
  505.     ENDIF
  506.  
  507. ;
  508. ; extern OSStatus ISpResume(void )
  509. ;
  510.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  511.         IMPORT_CFM_FUNCTION ISpResume
  512.     ENDIF
  513.  
  514. ; 
  515. ; * ISpDevices_Extract, ISpDevices_ExtractByClass, ISpDevices_ExtractByIdentifier
  516. ; *
  517. ; * These will extract as many device references from the system wide list as will fit in your buffer.  
  518. ; *
  519. ; * inBufferCount - the size of your buffer (in units of sizeof(ISpDeviceReference)) this may be zero
  520. ; * buffer - a pointer to your buffer
  521. ; * outCount - contains the number of devices in the system
  522. ; *
  523. ; * ISpDevices_ExtractByClass extracts and counts devices of the specified ISpDeviceClass
  524. ; * ISpDevices_ExtractByIdentifier extracts and counts devices of the specified ISpDeviceIdentifier
  525. ; *
  526. ; * Return Codes
  527. ; * paramErr
  528. ; *
  529. ; 
  530.  
  531. ;
  532. ; extern OSStatus ISpDevices_Extract(UInt32 inBufferCount, UInt32 *outCount, ISpDeviceReference *buffer)
  533. ;
  534.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  535.         IMPORT_CFM_FUNCTION ISpDevices_Extract
  536.     ENDIF
  537.  
  538. ;
  539. ; extern OSStatus ISpDevices_ExtractByClass(ISpDeviceClass inClass, UInt32 inBufferCount, UInt32 *outCount, ISpDeviceReference *buffer)
  540. ;
  541.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  542.         IMPORT_CFM_FUNCTION ISpDevices_ExtractByClass
  543.     ENDIF
  544.  
  545. ;
  546. ; extern OSStatus ISpDevices_ExtractByIdentifier(ISpDeviceIdentifier inIdentifier, UInt32 inBufferCount, UInt32 *outCount, ISpDeviceReference *buffer)
  547. ;
  548.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  549.         IMPORT_CFM_FUNCTION ISpDevices_ExtractByIdentifier
  550.     ENDIF
  551.  
  552.  
  553. ; 
  554. ; * ISpDevices_ActivateClass, ISpDevices_DeactivateClass, ISpDevices_Activate, ISpDevices_Deactivate, ISpDevice_IsActive
  555. ; *
  556. ; * ISpDevices_Activate, ISpDevices_Deactivate
  557. ; *
  558. ; * This will activate/deactivate a block of devices.
  559. ; * inDeviceCount - the number of devices to activate / deactivate
  560. ; * inDevicesToActivate/inDevicesToDeactivate - a pointer to a block of memory contains the devices references
  561. ; *
  562. ; * ISpDevices_ActivateClass, ISpDevices_DeactivateClass
  563. ; * inClass - the class of devices to activate or deactivate
  564. ; *
  565. ; * ISpDevice_IsActive
  566. ; * inDevice - the device reference that you wish to 
  567. ; * outIsActive - a boolean value that is true when the device is active
  568. ; *
  569. ; * Return Codes
  570. ; * paramErr
  571. ; *
  572. ; 
  573.  
  574. ;
  575. ; extern OSStatus ISpDevices_ActivateClass(ISpDeviceClass inClass)
  576. ;
  577.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  578.         IMPORT_CFM_FUNCTION ISpDevices_ActivateClass
  579.     ENDIF
  580.  
  581. ;  1.1 or later
  582. ;
  583. ; extern OSStatus ISpDevices_DeactivateClass(ISpDeviceClass inClass)
  584. ;
  585.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  586.         IMPORT_CFM_FUNCTION ISpDevices_DeactivateClass
  587.     ENDIF
  588.  
  589. ;  1.1 or later
  590. ;
  591. ; extern OSStatus ISpDevices_Activate(UInt32 inDeviceCount, ISpDeviceReference *inDevicesToActivate)
  592. ;
  593.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  594.         IMPORT_CFM_FUNCTION ISpDevices_Activate
  595.     ENDIF
  596.  
  597. ;
  598. ; extern OSStatus ISpDevices_Deactivate(UInt32 inDeviceCount, ISpDeviceReference *inDevicesToDeactivate)
  599. ;
  600.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  601.         IMPORT_CFM_FUNCTION ISpDevices_Deactivate
  602.     ENDIF
  603.  
  604. ;
  605. ; extern OSStatus ISpDevice_IsActive(ISpDeviceReference inDevice, Boolean *outIsActive)
  606. ;
  607.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  608.         IMPORT_CFM_FUNCTION ISpDevice_IsActive
  609.     ENDIF
  610.  
  611. ; 
  612. ; * ISpDevice_GetDefinition
  613. ; *
  614. ; *
  615. ; * inDevice - the device you want to get the definition for
  616. ; * inBuflen - the size of the structure (sizeof(ISpDeviceDefinition))
  617. ; * outStruct - a pointer to where you want the structure copied
  618. ; *
  619. ; * Return Codes
  620. ; * paramErr
  621. ; *
  622. ; 
  623.  
  624. ;
  625. ; extern OSStatus ISpDevice_GetDefinition(ISpDeviceReference inDevice, UInt32 inBuflen, ISpDeviceDefinition *outStruct)
  626. ;
  627.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  628.         IMPORT_CFM_FUNCTION ISpDevice_GetDefinition
  629.     ENDIF
  630.  
  631.  
  632. ; 
  633. ; *
  634. ; * ISpDevice_GetElementList
  635. ; *
  636. ; * inDevice - the device whose element list you wish to get
  637. ; * outElementList - a pointer to where you want a reference to that list stored
  638. ; *
  639. ; * Return Codes
  640. ; * paramErr
  641. ; *
  642. ; 
  643.  
  644. ;
  645. ; extern OSStatus ISpDevice_GetElementList(ISpDeviceReference inDevice, ISpElementListReference *outElementList)
  646. ;
  647.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  648.         IMPORT_CFM_FUNCTION ISpDevice_GetElementList
  649.     ENDIF
  650.  
  651. ; 
  652. ; *
  653. ; * takes an ISpElementReference and returns the group that it is in or 0 if there is
  654. ; * no group
  655. ; *
  656. ; * Return Codes
  657. ; * paramErr
  658. ; *
  659. ; 
  660.  
  661. ;
  662. ; extern OSStatus ISpElement_GetGroup(ISpElementReference inElement, UInt32 *outGroup)
  663. ;
  664.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  665.         IMPORT_CFM_FUNCTION ISpElement_GetGroup
  666.     ENDIF
  667.  
  668. ; 
  669. ; *
  670. ; * takes an ISpElementReference and returns the device that the element belongs 
  671. ; * to.
  672. ; *
  673. ; * Return Codes
  674. ; * paramErr if inElement is 0 or outDevice is nil
  675. ; *
  676. ; 
  677.  
  678. ;
  679. ; extern OSStatus ISpElement_GetDevice(ISpElementReference inElement, ISpDeviceReference *outDevice)
  680. ;
  681.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  682.         IMPORT_CFM_FUNCTION ISpElement_GetDevice
  683.     ENDIF
  684.  
  685. ; 
  686. ; *
  687. ; * takes an ISpElementReference and gives the ISpElementInfo for that Element.  This is the
  688. ; * the set of standard information.  You get ISpElementKind specific information
  689. ; * through ISpElement_GetConfigurationInfo.
  690. ; *
  691. ; * Return Codes
  692. ; * paramErr if inElement is 0 or outInfo is nil
  693. ; *
  694. ; 
  695.  
  696. ;
  697. ; extern OSStatus ISpElement_GetInfo(ISpElementReference inElement, ISpElementInfoPtr outInfo)
  698. ;
  699.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  700.         IMPORT_CFM_FUNCTION ISpElement_GetInfo
  701.     ENDIF
  702.  
  703. ; 
  704. ; *
  705. ; *         
  706. ; *
  707. ; * takes an ISpElementReference and gives the ISpElementKind specific configuration information
  708. ; * 
  709. ; * if buflen is not long enough to hold the information ISpElement_GetConfigurationInfo will
  710. ; * copy buflen bytes of the data into the block of memory pointed to by configInfo and
  711. ; * will return something error.
  712. ; *
  713. ; * Return Codes
  714. ; * paramErr if inElement or configInfo is nil
  715. ; *
  716. ; 
  717.  
  718. ;
  719. ; extern OSStatus ISpElement_GetConfigurationInfo(ISpElementReference inElement, UInt32 buflen, void *configInfo)
  720. ;
  721.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  722.         IMPORT_CFM_FUNCTION ISpElement_GetConfigurationInfo
  723.     ENDIF
  724.  
  725. ; 
  726. ; *
  727. ; * ISpElement_GetSimpleState
  728. ; *
  729. ; * Takes an ISpElementReference and returns the current state of that element.  This is a 
  730. ; * specialized version of ISpElement_GetComplexState that is only appropriate for elements
  731. ; * whose data fits in a signed 32 bit integer.
  732. ; *
  733. ; *
  734. ; *
  735. ; * Return Codes
  736. ; * paramErr if inElement is 0 or state is nil
  737. ; *
  738. ; 
  739.  
  740. ;
  741. ; extern OSStatus ISpElement_GetSimpleState(ISpElementReference inElement, UInt32 *state)
  742. ;
  743.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  744.         IMPORT_CFM_FUNCTION ISpElement_GetSimpleState
  745.     ENDIF
  746.  
  747. ; 
  748. ; *
  749. ; * ISpElement_GetComplexState
  750. ; *
  751. ; * Takes an ISpElementReference and returns the current state of that element.  
  752. ; * Will copy up to buflen bytes of the current state of the device into
  753. ; * state.
  754. ; *
  755. ; *
  756. ; * Return Codes
  757. ; * paramErr if inElement is 0 or state is nil
  758. ; *
  759. ; 
  760.  
  761. ;
  762. ; extern OSStatus ISpElement_GetComplexState(ISpElementReference inElement, UInt32 buflen, void *state)
  763. ;
  764.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  765.         IMPORT_CFM_FUNCTION ISpElement_GetComplexState
  766.     ENDIF
  767.  
  768.  
  769. ; 
  770. ; * ISpElement_GetNextEvent
  771. ; *
  772. ; * It takes in an element  reference and the buffer size of the ISpElementEventPtr
  773. ; * it will set wasEvent to true if there was an event and false otherwise.  If there
  774. ; * was not enough space to fill in the whole event structure that event will be
  775. ; * dequed, as much of the event as will fit in the buffer will by copied and
  776. ; * ISpElement_GetNextEvent will return an error.
  777. ; *
  778. ; * Return Codes
  779. ; * paramErr
  780. ; *
  781. ; 
  782.  
  783. ;
  784. ; extern OSStatus ISpElement_GetNextEvent(ISpElementReference inElement, UInt32 bufSize, ISpElementEventPtr event, Boolean *wasEvent)
  785. ;
  786.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  787.         IMPORT_CFM_FUNCTION ISpElement_GetNextEvent
  788.     ENDIF
  789.  
  790. ; 
  791. ; *
  792. ; * ISpElement_Flush
  793. ; *
  794. ; * It takes an ISpElementReference and flushes all the events on that element.  All it guaruntees is
  795. ; * that any events that made it to this layer before the time of the flush call will be flushed and
  796. ; * it will not flush any events that make it to this layer after the time when the call has returned.
  797. ; * What happens to events that occur during the flush is undefined.
  798. ; *
  799. ; *
  800. ; * Return Codes
  801. ; * paramErr
  802. ; *
  803. ; 
  804.  
  805. ;
  806. ; extern OSStatus ISpElement_Flush(ISpElementReference inElement)
  807. ;
  808.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  809.         IMPORT_CFM_FUNCTION ISpElement_Flush
  810.     ENDIF
  811.  
  812.  
  813.  
  814. ; 
  815. ; * ISpElementList_New
  816. ; *
  817. ; * Creates a new element list and returns it in outElementList.  In count specifies 
  818. ; * the number of element references in the list pointed to by inElements.  If inCount
  819. ; * is non zero the list is created with inCount elements in at as specified by the 
  820. ; * inElements parameter.  Otherwise the list is created empty.
  821. ; *
  822. ; *
  823. ; * Return Codes
  824. ; * out of memory - If it failed to allocate the list because it was out of memory
  825. ;                   it will also set outElementList to 0
  826. ; * paramErr if outElementList was nil
  827. ; *
  828. ; *
  829. ; * Special Concerns
  830. ; *
  831. ; * interrupt unsafe
  832. ; *
  833. ; 
  834.  
  835. ;
  836. ; extern OSStatus ISpElementList_New(UInt32 inCount, ISpElementReference *inElements, ISpElementListReference *outElementList, UInt32 flags)
  837. ;
  838.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  839.         IMPORT_CFM_FUNCTION ISpElementList_New
  840.     ENDIF
  841.  
  842. ; 
  843. ; * ISpElementList_Dispose
  844. ; *
  845. ; * Deletes an already existing memory list.  
  846. ; *
  847. ; *
  848. ; * Return Codes
  849. ; * paramErr if inElementList was 0
  850. ; *
  851. ; *
  852. ; * Special Concerns
  853. ; *
  854. ; * interrupt unsafe
  855. ; *
  856. ; 
  857.  
  858. ;
  859. ; extern OSStatus ISpElementList_Dispose(ISpElementListReference inElementList)
  860. ;
  861.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  862.         IMPORT_CFM_FUNCTION ISpElementList_Dispose
  863.     ENDIF
  864.  
  865. ; 
  866. ; * ISpGetGlobalElementList
  867. ; *
  868. ; * returns the global element list
  869. ; *
  870. ; * Return Codes
  871. ; * paramErr if outElementList is nil
  872. ; *
  873. ; 
  874.  
  875. ;
  876. ; extern OSStatus ISpGetGlobalElementList(ISpElementListReference *outElementList)
  877. ;
  878.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  879.         IMPORT_CFM_FUNCTION ISpGetGlobalElementList
  880.     ENDIF
  881.  
  882. ; 
  883. ; * ISpElementList_AddElement
  884. ; *
  885. ; * adds an element to the element list
  886. ; *
  887. ; * Return Codes
  888. ; * paramErr if inElementList is 0 or newElement is 0
  889. ; * memory error if the system is unable to allocate enough memory
  890. ; *
  891. ; * Special Concerns
  892. ; * interrupt Unsafe
  893. ; * 
  894. ; 
  895.  
  896. ;
  897. ; extern OSStatus ISpElementList_AddElements(ISpElementListReference inElementList, UInt32 refCon, UInt32 count, ISpElementReference *newElements)
  898. ;
  899.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  900.         IMPORT_CFM_FUNCTION ISpElementList_AddElements
  901.     ENDIF
  902.  
  903. ; 
  904. ; * ISpElementList_RemoveElement
  905. ; *
  906. ; * removes the specified element from the element list
  907. ; *
  908. ; * Return Codes
  909. ; * paramErr if inElementList is 0 or oldElement is 0
  910. ; * memory error if the system is unable to allocate enough memory
  911. ; *
  912. ; * Special Concerns
  913. ; * interrupt Unsafe
  914. ; * 
  915. ; 
  916.  
  917. ;
  918. ; extern OSStatus ISpElementList_RemoveElements(ISpElementListReference inElementList, UInt32 count, ISpElementReference *oldElement)
  919. ;
  920.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  921.         IMPORT_CFM_FUNCTION ISpElementList_RemoveElements
  922.     ENDIF
  923.  
  924. ; 
  925. ; * ISpElementList_Extract
  926. ; *
  927. ; * ISpElementList_Extract will extract as many of the elements from an element list as possible.  You pass
  928. ; * in an element list, a pointer to an array of element references and the number of elements in that array.
  929. ; * It will return how many items are in the element list in the outCount parameter and copy the minimum of 
  930. ; * that number and the size of the array into the buffer.
  931. ; *
  932. ; * ByKind and ByLabel are the same except that they will only count and copy element references to elements
  933. ; * that have the specified kind and label.
  934. ; *
  935. ; * Return Codes
  936. ; * paramErr
  937. ; *
  938. ; 
  939.  
  940. ;
  941. ; extern OSStatus ISpElementList_Extract(ISpElementListReference inElementList, UInt32 inBufferCount, UInt32 *outCount, ISpElementReference *buffer)
  942. ;
  943.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  944.         IMPORT_CFM_FUNCTION ISpElementList_Extract
  945.     ENDIF
  946.  
  947. ;
  948. ; extern OSStatus ISpElementList_ExtractByKind(ISpElementListReference inElementList, ISpElementKind inKind, UInt32 inBufferCount, UInt32 *outCount, ISpElementReference *buffer)
  949. ;
  950.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  951.         IMPORT_CFM_FUNCTION ISpElementList_ExtractByKind
  952.     ENDIF
  953.  
  954. ;
  955. ; extern OSStatus ISpElementList_ExtractByLabel(ISpElementListReference inElementList, ISpElementLabel inLabel, UInt32 inBufferCount, UInt32 *outCount, ISpElementReference *buffer)
  956. ;
  957.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  958.         IMPORT_CFM_FUNCTION ISpElementList_ExtractByLabel
  959.     ENDIF
  960.  
  961. ; 
  962. ; * ISpElementList_GetNextEvent
  963. ; *
  964. ; * It takes in an element list reference and the buffer size of the ISpElementEventPtr
  965. ; * it will set wasEvent to true if there was an event and false otherwise.  If there
  966. ; * was not enough space to fill in the whole event structure that event will be
  967. ; * dequed, as much of the event as will fit in the buffer will by copied and
  968. ; * ISpElementList_GetNextEvent will return an error.
  969. ; *
  970. ; * Return Codes
  971. ; * paramErr
  972. ; *
  973. ; 
  974.  
  975. ;
  976. ; extern OSStatus ISpElementList_GetNextEvent(ISpElementListReference inElementList, UInt32 bufSize, ISpElementEventPtr event, Boolean *wasEvent)
  977. ;
  978.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  979.         IMPORT_CFM_FUNCTION ISpElementList_GetNextEvent
  980.     ENDIF
  981.  
  982. ; 
  983. ; *
  984. ; * ISpElementList_Flush
  985. ; *
  986. ; * It takes an ISpElementListReference and flushes all the events on that list.  All it guaruntees is
  987. ; * that any events that made it to this layer before the time of the flush call will be flushed and
  988. ; * it will not flush any events that make it to this layer after the time when the call has returned.
  989. ; * What happens to events that occur during the flush is undefined.
  990. ; *
  991. ; *
  992. ; * Return Codes
  993. ; * paramErr
  994. ; *
  995. ; 
  996.  
  997. ;
  998. ; extern OSStatus ISpElementList_Flush(ISpElementListReference inElementList)
  999. ;
  1000.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1001.         IMPORT_CFM_FUNCTION ISpElementList_Flush
  1002.     ENDIF
  1003.  
  1004. ; 
  1005. ; *
  1006. ; * ISpTimeToMicroseconds
  1007. ; *
  1008. ; *
  1009. ; * This function takes time from an input sprocket event and converts it
  1010. ; * into microseconds. (Version 1.2 or later of InputSprocket.)
  1011. ; *
  1012. ; *
  1013. ; * Return Codes
  1014. ; * paramErr
  1015. ; *
  1016. ; 
  1017.  
  1018. ;
  1019. ; extern OSStatus ISpTimeToMicroseconds(const AbsoluteTime *inTime, UnsignedWide *outMicroseconds)
  1020. ;
  1021.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1022.         IMPORT_CFM_FUNCTION ISpTimeToMicroseconds
  1023.     ENDIF
  1024.  
  1025.  
  1026.     ENDIF    ; TARGET_CPU_PPC
  1027.  
  1028.     ENDIF ; __INPUTSPROCKET__ 
  1029.  
  1030.